docs: Better explain gotchas with the config options #552
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SVGR has some internal SVGO config changes that aren't documented which differ from upstream SVGO defaults. The `dimensions` option was documented in a way that was easy to be confused (previously the `Default` was `false` but was later documented as `true` without updating the description or CLI option), this has been better addressed.
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/gregberge/svgr/ERKTLFoy6pbSzdz3Kxr4Q8WRwd9W |
Codecov Report
@@ Coverage Diff @@
## main #552 +/- ##
=======================================
Coverage 87.19% 87.19%
=======================================
Files 31 31
Lines 570 570
Branches 160 160
=======================================
Hits 497 497
Misses 58 58
Partials 15 15 Continue to review full report at Codecov.
|
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
SVGR has some internal SVGO config changes that aren't documented which differ from upstream SVGO defaults.
The
dimensionsoption was documented in a way that was easy to be confused (previously theDefaultwasfalsebut was later documented astruewithout updating the description or CLI option), this has been better addressed.Additionally collapsed some lines that were split to multi-line, and minor grammar fixes or improvements.
Resolves: #547
Resolves: #550